Node / ReticulumProjects / Reticulum.git / files / docs / source / reference.rst

Displaying Raw • Download

T56d364:tocdepth: 4

Tb4b4b4.. Tff7b72_api-main:

Tc9d1d9*************

Tc9d1d9API Reference

Tc9d1d9*************

Communication over Reticulum networks is achieved by using a simple set of classes exposed by the RNS API.

This chapter lists and explains all classes exposed by the Reticulum Network Stack API, along with their method signatures and usage. It can be used as a reference while writing applications that utilise Reticulum, or it can be read in entirity to gain an understanding of the complete functionality of RNS from a developers perspective.

Tb4b4b4.. Tff7b72_api-reticulum:

Tb4b4b4.. Tff7b72onlyTb4b4b4:: html

|start-h3| Reticulum |end-h3|

Tb4b4b4.. Tff7b72onlyTb4b4b4:: latex

Reticulum

---------

Tb4b4b4.. Tff7b72autoclassTb4b4b4:: RNS.Reticulum

T56d364:members:

Tb4b4b4.. Tff7b72_api-identity:

Tb4b4b4.. Tff7b72onlyTb4b4b4:: html

|start-h3| Identity |end-h3|

Tb4b4b4.. Tff7b72onlyTb4b4b4:: latex

Identity

--------

Tb4b4b4.. Tff7b72autoclassTb4b4b4:: RNS.Identity

T56d364:members:

Tb4b4b4.. Tff7b72_api-destination:

Tb4b4b4.. Tff7b72onlyTb4b4b4:: html

|start-h3| Destination |end-h3|

Tb4b4b4.. Tff7b72onlyTb4b4b4:: latex

Destination

-----------

Tb4b4b4.. Tff7b72autoclassTb4b4b4:: RNS.Destination

T56d364:members:

Tb4b4b4.. Tff7b72_api-packet:

Tb4b4b4.. Tff7b72onlyTb4b4b4:: html

|start-h3| Packet |end-h3|

Tb4b4b4.. Tff7b72onlyTb4b4b4:: latex

Packet

------

Tb4b4b4.. Tff7b72autoclassTb4b4b4:: RNS.Packet(destination, data, create_receipt = True)

T56d364:members:

Tb4b4b4.. Tff7b72_api-packetreceipt:

Tb4b4b4.. Tff7b72onlyTb4b4b4:: html

|start-h3| Packet Receipt |end-h3|

Tb4b4b4.. Tff7b72onlyTb4b4b4:: latex

Packet Receipt

--------------

Tb4b4b4.. Tff7b72autoclassTb4b4b4:: RNS.PacketReceipt()

T56d364:members:

Tb4b4b4.. Tff7b72_api-link:

Tb4b4b4.. Tff7b72onlyTb4b4b4:: html

|start-h3| Link |end-h3|

Tb4b4b4.. Tff7b72onlyTb4b4b4:: latex

Link

----

Tb4b4b4.. Tff7b72autoclassTb4b4b4:: RNS.Link(destination, established_callback=None, closed_callback = None)

T56d364:members:

Tb4b4b4.. Tff7b72_api-requestreceipt:

Tb4b4b4.. Tff7b72onlyTb4b4b4:: html

|start-h3| Request Receipt |end-h3|

Tb4b4b4.. Tff7b72onlyTb4b4b4:: latex

Request Receipt

---------------

Tb4b4b4.. Tff7b72autoclassTb4b4b4:: RNS.RequestReceipt()

T56d364:members:

Tb4b4b4.. Tff7b72_api-resource:

Tb4b4b4.. Tff7b72onlyTb4b4b4:: html

|start-h3| Resource |end-h3|

Tb4b4b4.. Tff7b72onlyTb4b4b4:: latex

Resource

--------

Tb4b4b4.. Tff7b72autoclassTb4b4b4:: RNS.Resource(data, link, advertise=True, auto_compress=True, callback=None, progress_callback=None, timeout=None)

T56d364:members:

Tb4b4b4.. Tff7b72_api-channel:

Tb4b4b4.. Tff7b72onlyTb4b4b4:: html

|start-h3| Channel |end-h3|

Tb4b4b4.. Tff7b72onlyTb4b4b4:: latex

Channel

-------

Tb4b4b4.. Tff7b72autoclassTb4b4b4:: RNS.Channel.Channel()

T56d364:members:

Tb4b4b4.. Tff7b72_api-messsagebase:

Tb4b4b4.. Tff7b72onlyTb4b4b4:: html

|start-h3| MessageBase |end-h3|

Tb4b4b4.. Tff7b72onlyTb4b4b4:: latex

MessageBase

-----------

Tb4b4b4.. Tff7b72autoclassTb4b4b4:: RNS.MessageBase()

T56d364:members:

Tb4b4b4.. Tff7b72_api-buffer:

Tb4b4b4.. Tff7b72onlyTb4b4b4:: html

|start-h3| Buffer |end-h3|

Tb4b4b4.. Tff7b72onlyTb4b4b4:: latex

Buffer

------

Tb4b4b4.. Tff7b72autoclassTb4b4b4:: RNS.Buffer

T56d364:members:

Tb4b4b4.. Tff7b72_api-rawchannelreader:

Tb4b4b4.. Tff7b72onlyTb4b4b4:: html

|start-h3| RawChannelReader |end-h3|

Tb4b4b4.. Tff7b72onlyTb4b4b4:: latex

RawChannelReader

----------------

Tb4b4b4.. Tff7b72autoclassTb4b4b4:: RNS.RawChannelReader

T56d364:members: __init__, add_ready_callback, remove_ready_callback

Tb4b4b4.. Tff7b72_api-rawchannelwriter:

Tb4b4b4.. Tff7b72onlyTb4b4b4:: html

|start-h3| RawChannelWriter |end-h3|

Tb4b4b4.. Tff7b72onlyTb4b4b4:: latex

RawChannelWriter

----------------

Tb4b4b4.. Tff7b72autoclassTb4b4b4:: RNS.RawChannelWriter

T56d364:members: __init__

Tb4b4b4.. Tff7b72_api-transport:

Tb4b4b4.. Tff7b72onlyTb4b4b4:: html

|start-h3| Transport |end-h3|

Tb4b4b4.. Tff7b72onlyTb4b4b4:: latex

Transport

---------

Tb4b4b4.. Tff7b72autoclassTb4b4b4:: RNS.Transport

T56d364:members:

Tb4b4b4.. Tff7b72|start-h3| Tff7b72rawTb4b4b4:: html

<h3>

Tb4b4b4.. Tff7b72|end-h3| Tff7b72rawTb4b4b4:: html

</h3>